Port Cvar_Prefix.h and ConfigUpdater from SoH #1339

Glought · 2025-11-12T02:51:01Z

I have port over Cvar_Prefix.h from SoH.

While working on my other PR #1325 I saw inconsistency with the Cvar naming

Example
In BenMenu.cpp:

AddWidget(path, "Fix Console Crashes", WIDGET_CVAR_CHECKBOX)
        .CVar("gEnhancements.Fixes.ConsoleCrashes")
AddWidget(path, "Fix Ammo Count Color", WIDGET_CVAR_CHECKBOX)'
        .CVar("gFixes.FixAmmoCountEnvColor")'

AddWidget(path, "Popout Gfx Debugger", WIDGET_WINDOW_BUTTON)'
        .CVar("gOpenWindows.GfxDebugger")'
AddWidget(path, "Popout Hook Debugger", WIDGET_WINDOW_BUTTON)'
        .CVar("gWindows.HookDebugger")`

I thought I'll help by implementing how its done in SoH.

CVAR MACRO	Prefix	Notes
CVAR_RANDOMIZER	"gRando."	Added
CVAR_RANDOMIZER_ENHANCEMENT	"gRando.Enhancement."	(Future use)
CVAR_RANDOMIZER_SETTING	"gRando.Setting."	(Future use)
CVAR_COSMETIC	"gCosmetics."
CVAR_AUDIO	"gAudioEditor."
CVAR_CHEAT	"gCheats."
CVAR_ENHANCEMENT	"gEnhancements."
CVAR_SETTING	"gSettings."
CVAR_WINDOW	"gOpenWindows."
CVAR_TRACKER	"gTrackers."
CVAR_TRACKER_ITEM	"gTrackers.ItemTracker."
CVAR_TRACKER_CHECK	"gTrackers.CheckTracker."
CVAR_TRACKER_ENTRANCE	"gTracker.EntraceTracker."	(Future use)
CVAR_TRACKER_TIMESPLITS	"gTrackers.TimeSplitsTracker."
CVAR_DEVELOPER_TOOLS	"gDeveloperTools."
CVAR_GENERAL	"gGeneral."	(Future use)
CVAR_REMOTE	"gRemote."	(Future use)
CVAR_REMOTE_CROWD_CONTROL	"gRemote.CrowdControl."	(Future use)
CVAR_REMOTE_SAIL	"gRemote.Sail."	(Future use)
CVAR_GAMEPLAY_STATS	"gGameplayStats."	(Future use)
CVAR_TIME_DISPLAY	"gTimeDisplay."	(Future use)
CVAR_INPUT_VIEWER	"gInputViewer."

With this lines like
Before:

AddWidget(path, "Fix Console Crashes", WIDGET_CVAR_CHECKBOX)
        .CVar("gEnhancements.Fixes.ConsoleCrashes")
AddWidget(path, "Fix Ammo Count Color", WIDGET_CVAR_CHECKBOX)'
        .CVar("gFixes.FixAmmoCountEnvColor")

After

AddWidget(path, "Fix Console Crashes", WIDGET_CVAR_CHECKBOX)
        .CVar(CVAR_ENHANCEMENT("Fixes.ConsoleCrashes"))
AddWidget(path, "Fix Ammo Count Color", WIDGET_CVAR_CHECKBOX)'
        .CVar(CVAR_ENHANCEMENT("Fixes.FixAmmoCountEnvColor")'

Moved Cvars:

I have reorganized CVars

Cvar	Cvar Macro	Expansion
"ItemTracker"	CVAR_TRACKER_ITEM(*)	"gTracker.ItemTracker.*"
"gRando.CheckTracker"	CVAR_TRACKER_CHECK(*)	"gTracker.CheckTracker.*"
"gSettings.TimeSplits"	CVAR_TRACKER_TIMESPLITS(*)	"gTracker.TimeSplitsTracker.*"
"gMatchRefreshRate"	CVAR_SETTING("Graphics.MatchRefreshRate")	"gSettings.Graphics.gMatchRefreshRate"
"gInterpolationFPS"	CVAR_SETTING("Graphics.InterpolationFPS")	"gSettings.Graphics.InterpolationFPS"
"gNotifications"	CVAR_SETTING("Notifications.*")	"gSettings.Notifications.*"
"gSettings.AdvancedResolution"	CVAR_SETTING("Graphics.AdvancedResolution.*")	"gSettings.Graphics.AdvancedResolution.*"
"gDisplayOverlay"	CVAR_SETTING("DisplayOverlay.*")	"gSettings.DisplayOverlay.*"
"gEventLog"	CVAR_DEVELOPER_TOOLS("EventLog.*")	"gDeveloperTools.EventLog.*"
"gCollisionViewer"	CVAR_DEVELOPER_TOOLS("CollisionViewer.*")	"gDeveloperTools.CollisionViewer.*"
"gModes"	CVAR_ENHANCEMENT("Modes.*")	"gEnhancements.Modes.*"
"gFixes"	CVAR_ENHANCEMENT("Fixes.*")	"gEnhancements.Fixes.*"
"gWindows"	gOpenWindows("*")	"gOpenWindows.*"

Configuration Migration

To make this as seamless I have ported over ConfigUpdater from SoH.
I have set it up to Migrate the Cvars I moved.

Here is a "2ship2harkinian.json" file for testing it has everything enabled.
2ship2harkinian.json

Build Artifacts

Added "CVAR_PREFIX_GAMEPLAY_STATS" and "CVAR_PREFIX_TIME_DISPLAY" to "2ship-cvars.cmake"

Added Include "Cvar_Prefixes.h" to "AudioCollection.cpp" and "AudioEditor.cpp"

Changed code that uses "gOpenWindows." to the "CVAR_WINDOW" macro.

…S" macro.

Removed "CVAR_PREFIX_RANDOMIZER_ENHANCEMENT" macro. Removed "CVAR_PREFIX_RANDOMIZER_SETTING" macro. Added "CVAR_RANDOMIZER" macro to "cvar_prefixes.h" Kept "CVAR_RANDOMIZER_ENHANCEMENT" and "CVAR_RANDOMIZER_SETTING" macros for future use. Changed code that uses "gRando." to the "CVAR_RANDOMIZER" macro.

Changed lines that used "CFG_TRACKER_ITEM" to the "CVAR_TRACKER_ITEM" macro.

"CVAR_TRACKER_CHECK" macro in "CheckTracker.cpp".

macro.

"gWindows", and "ItemTracker" Added "gTrackers" to "defaultsPresetJ" and "TagMap".

the "CVAR_SETTING("Graphics.AdvancedResolution.*") macro.

…LS("CollisionViewer.*")" macro.

…ntLog.*")" macro.

Cvar_Prefix macro Added a Include guard to "cvar_prefixes.h"

Changed code that uses "CVAR_SETTING("TimeSplits.*)" macro to use the "CVAR_TRACKER_TIMESPLITS" macro.

"CVAR_SETTING("Notifications.*)" macro

"CVAR_SETTING("DisplayOverlay.*)" macro.

"CVAR_SETTING("Graphics.InterpolationFPS")" macro.

"CVAR_SETTING("Graphics.MatchRefreshRate")" macro.

"gEventLog", and "gNotifications".

"CVAR_AUDIO("*")" macro.

"CVAR_ENHANCEMENT("*")" macro.

"CVAR_DEVELOPER_TOOLS("*")" macro.

"CVAR_TRACKER_ITEM("*")" macro.

"CVAR_WINDOW("*")" macro.

"CVAR_SETTING("*")" macro.

"cvar_prefixes.h" Add #include "2s2h/cvar_prefixes.h" to to files that uses a Cvar_Prefix macro.

CVAR_PREFIXES.

garrettjoecox · 2026-01-17T18:42:02Z

Hey @Glought thanks for the PR! Sorry for such a long delay on a response and to have left you updating this multiple times. As soon as this went up it sparked some discussion in internal channels but they kind of lingered for a while, and I've landed on wanting to hold off on bringing this pattern over to 2ship.

While there is an obvious benefit of enforcing the common cvar prefixes, it's not as large of a problem on 2ship as it ever was on SoH because of our more limited and careful placement of cvars, and the problem is slowly getting smaller on SoH even as they adapt some of the newer patterns. IMO it makes cvar usage a bit more clunky and my editor is constantly fighting it on SoH with these macros not evaluating correctly or whatever.

I want to revisit the entirety of CVars and config usage because there have been several pain points we've had to work through over the years, but that's a much bigger undertaking and beyond the scope of this PR.

Once again we appreciate the PR along with your others! But we're going to pass on this one for the time being.

Glought · 2026-01-17T20:58:42Z

Ty for letting me know your decision

Glought force-pushed the cvar_prefixes branch 2 times, most recently from 9995571 to 46f4802 Compare November 13, 2025 13:41

Glought changed the title ~~Ported Cvar_Prefix.h and ConfigUpdater from SoH~~ Port Cvar_Prefix.h and ConfigUpdater from SoH Nov 14, 2025

Glought force-pushed the cvar_prefixes branch 4 times, most recently from 45fedd6 to c3a10dc Compare November 27, 2025 22:06

Eblo mentioned this pull request Nov 29, 2025

Eliminate magic strings as CVar names #1370

Open

Glought added 22 commits December 27, 2025 01:01

Ported "cvar_prefixes.h" Header file from SoH.

2b5cb77

Added "CVAR_PREFIX_GAMEPLAY_STATS" and "CVAR_PREFIX_TIME_DISPLAY" to "2ship-cvars.cmake"

Changed code that uses "gCosmetics." to the "CVAR_COSMETIC" macro.

cac6fee

Removed Redundant "CVAR_AUDIO" macro.

c455b41

Added Include "Cvar_Prefixes.h" to "AudioCollection.cpp" and "AudioEditor.cpp"

Changed code that uses "gCheats." to the "CVAR_CHEAT" macro.

389fb8b

Changed code that uses "gEnhancements." to the "CVAR_ENHANCEMENT" macro.

f483af2

Changed code that uses "gSettings." to the "CVAR_SETTING" macro.

0fa4f1b

Changed code that uses "gWindows." to the "CVAR_WINDOW" macro.

a6fefa1

Changed code that uses "gOpenWindows." to the "CVAR_WINDOW" macro.

Changed code that uses "gDeveloperTools." to the "CVAR_DEVELOPER_TOOL…

cb409e2

…S" macro.

Removed "CFG_TRACKER_ITEM" macro in "ItemTracker.cpp".

8761b84

Changed lines that used "CFG_TRACKER_ITEM" to the "CVAR_TRACKER_ITEM" macro.

Changed code that used the "CVAR_RANDOMIZER" macro to the

1cf60fe

"CVAR_TRACKER_CHECK" macro in "CheckTracker.cpp".

Changed code that uses "gModes." to the "CVAR_ENHANCEMENT("Modes.*")"

1132591

macro.

Changed code that uses "gFixes" to the "CVAR_ENHANCEMENT("Fixes.*")"

acdffbb

macro.

Updated PresetManager to reflect changes to "gFixes", "gModes",

2744f92

"gWindows", and "ItemTracker" Added "gTrackers" to "defaultsPresetJ" and "TagMap".

Changed Code the uses "CVAR_PREFIX_ADVANCED_RESOLUTION" to

e3b5634

the "CVAR_SETTING("Graphics.AdvancedResolution.*") macro.

Ran Clang Format

dabe5b0

Changed code that uses "gCollisionViewer." to the "CVAR_DEVELOPER_TOO…

90a61c8

…LS("CollisionViewer.*")" macro.

Changed code that uses "gEventLog." to the "CVAR_DEVELOPER_TOOLS("Eve…

5ec0ed9

…ntLog.*")" macro.

Added "#include "2s2h/cvar_prefixes.h"" to all files that uses a

25db9cc

Cvar_Prefix macro Added a Include guard to "cvar_prefixes.h"

Added "CVAR_TRACKER_TIMESPLITS" macro.

ca58f76

Changed code that uses "CVAR_SETTING("TimeSplits.*)" macro to use the "CVAR_TRACKER_TIMESPLITS" macro.

Changed code that used "gNotifications." to use the

1e1925b

"CVAR_SETTING("Notifications.*)" macro

Changed code the used "gDisplayOverlay." to use the

fd382fa

"CVAR_SETTING("DisplayOverlay.*)" macro.

Glought added 15 commits December 27, 2025 01:17

Changed code that used "gInterpolationFPS" to use the

a49691d

"CVAR_SETTING("Graphics.InterpolationFPS")" macro.

Changed code that used "gMatchRefreshRate" to use the

5732ba6

"CVAR_SETTING("Graphics.MatchRefreshRate")" macro.

Ran Clang Format

f5650f4

Updated PresetManager to reflect changes to "gCollisionViewer",

c04e966

"gEventLog", and "gNotifications".

Ported "ConfigUpdater" from SoH.

0427dcc

Changed code that used "gAudioEditor.*" to use the

0d31dc8

"CVAR_AUDIO("*")" macro.

Changed code that used "gEnhancements.*" to use the

8273e48

"CVAR_ENHANCEMENT("*")" macro.

Changed code that used "gDeveloperTools.*" to use the

983d232

"CVAR_DEVELOPER_TOOLS("*")" macro.

Changed code that used "gSettings.ItemTracker.*" to use the

20a62d1

"CVAR_TRACKER_ITEM("*")" macro.

Changed code that used "gWindows.*" to use the

3694bb8

"CVAR_WINDOW("*")" macro.

Changed code that used "gSettings.*" to use the

518994d

"CVAR_SETTING("*")" macro.

Add "#define CVAR_INPUT_VIEWER(var) "gInputViewer." var" to

97ac85d

"cvar_prefixes.h" Add #include "2s2h/cvar_prefixes.h" to to files that uses a Cvar_Prefix macro.

Ran Clang Format

49f3fb0

Updated the new CVARs from the latest Commits as of 12-3-25 to use the

2027043

CVAR_PREFIXES.

Updated the new CVARs from the latest Commits as of 12-27-25 to use the

245c6dc

CVAR_PREFIXES.

Glought force-pushed the cvar_prefixes branch from 64ce3ff to 245c6dc Compare December 27, 2025 11:06

garrettjoecox closed this Jan 17, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Port Cvar_Prefix.h and ConfigUpdater from SoH #1339

Port Cvar_Prefix.h and ConfigUpdater from SoH #1339

Uh oh!

Glought commented Nov 12, 2025 •

edited by github-actions bot

Loading

Uh oh!

garrettjoecox commented Jan 17, 2026

Uh oh!

Glought commented Jan 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Port Cvar_Prefix.h and ConfigUpdater from SoH #1339

Port Cvar_Prefix.h and ConfigUpdater from SoH #1339

Uh oh!

Conversation

Glought commented Nov 12, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Moved Cvars:

Configuration Migration

Build Artifacts

Uh oh!

garrettjoecox commented Jan 17, 2026

Uh oh!

Glought commented Jan 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Glought commented Nov 12, 2025 •

edited by github-actions bot

Loading